Kubeedge Local Up Scirpt Guide #600
Conversation
kubeedge-bot
added
the
size/L
xuemingdi
changed the title
|
This pr is to add a script guide for Kubeedge local up which requested in: #433 |
xuemingdi
force-pushed
the
local_up_kubeedge
branch
from
d4a48ee to
b6946ff
Compare
docs/developer/local_up_kubeedge.md
Outdated
| 5. Shutting Down the Cluster: | ||
| If the cluster is no longer needed, you can use the cleanup function provided in the script to stop and clean up the cluster and related resources. | ||
|
|
||
| ```shell | ||
| cleanup | ||
| ``` |
There was a problem hiding this comment.
We can add a note: Users can directly use ctrl+c to terminate the script and call the cleanup function to clean up the environment
There was a problem hiding this comment.
Modified shutting down parts.
|
|
||
| 3. Container Runtime Installation: | ||
|
|
||
| Based on the user's choice of container runtime (docker, cri-o, isulad), the script attempts to install the corresponding runtime tools. | ||
| Checks and verifies the installation of Go language version, kubectl tool, and kind tool. |
There was a problem hiding this comment.
Would it be better to mention here that if the user does not set the container runtime, we will use containerd by default?
There was a problem hiding this comment.
Add note that containerd will be set by default.
docs/developer/local_up_kubeedge.md
Outdated
| ```shell | ||
| healthcheck | ||
| kubectl get nodes | grep edge-node | grep -q -w Ready && break | ||
| ``` |
There was a problem hiding this comment.
In my opinion, healthcheck is generally only used inside scripts. Users can directly check the kubeedge node status through the k8s API, so I recommend deleting healthcheck here.
There was a problem hiding this comment.
Removed that part in the usage steps, and mentioned in the script analysis that user could use k8s API to check the health status.
xuemingdi
force-pushed
the
local_up_kubeedge
branch
from
c95db7a to
570dd33
Compare
docs/developer/local_up_kubeedge.md
Outdated
| ```shell | ||
| hack/local_up_kubeedge.sh | ||
| ``` |
There was a problem hiding this comment.
the name of script is local-up-kubeedge.sh
There was a problem hiding this comment.
correct the script name
docs/developer/local_up_kubeedge.md
Outdated
|
|
||
| 1. Set environment variables | ||
|
|
||
| This script sets several environment variables at the beginning, including log directory, log level, timeout duration, protocol type, container runtime type, Kebenetes cluster name and etc. This is the necessary for local Kebeedge cluster setting up and starting. |
There was a problem hiding this comment.
| This script sets several environment variables at the beginning, including log directory, log level, timeout duration, protocol type, container runtime type, Kebenetes cluster name and etc. This is the necessary for local Kebeedge cluster setting up and starting. | |
| This script sets several environment variables at the beginning, including log directory, log level, timeout duration, protocol type, container runtime type, Kubernetes cluster name and etc. This is the necessary for local KubeEdge cluster setting up and starting. |
xuemingdi
force-pushed
the
local_up_kubeedge
branch
from
39d65fd to
258cbad
Compare
docs/developer/local_up_kubeedge.md
Outdated
| @@ -0,0 +1,170 @@ | |||
| --- | |||
| title: Kubeedge Local Up | |||
There was a problem hiding this comment.
| title: Kubeedge Local Up | |
| title: KubeEdge Local Up |
Signed-off-by: Xue Mingdi <[email protected]>
xuemingdi
force-pushed
the
local_up_kubeedge
branch
from
628c4c4 to
dd66596
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Shelley-BaoYue The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubeedge-bot
added
the
approved
Which issue(s) this PR fixes:
#433
Fixes #
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
docs update
What is the current behavior? (You can also link to an open issue here)
N.A
What is the new behavior (if this is a feature change)?
Add Kubeedge Local Upgrade Scirpt Guide
Umbrella Issue for KubeEdge Documentation Improvement #433
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No
Other information: